/**
 * # 参数列表实体类:
 *  Delete - 删除通知
 * 
 * # 描述:
 *  删除一条或者多条通知消息。已经阅读的消息不能被删除。
 *  
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

package com.waln.notifying.outbox.args;

/**
 * 功能 删除通知 的参数列表。
 */
@pittypat.FunctionAnnotation(transaction = true)
public final class Delete extends pittypat.FunctionArgs {
	/**
	 * 发送用户的 Id。
	 * <p>
	 * 发送消息的用户的 Id，如果是系统消息，则为 null。
	 */
	@pittypat.ParameterAnnotation(position = 0, role = pittypat.ParameterRole.USER_ID)
	public java.util.UUID senderId;

	/**
	 * 通知 Id 的列表。
	 * <p>
	 * 要被删除的通知消息的 Id 列表，多个之间使用 ',' 分隔。
	 */
	@pittypat.ParameterAnnotation(position = 1, maxLength = 4000)
	public String ids;

	/**
	 * 附件路径列表。
	 * <p>
	 * 被删除的通知消息对应的附件的路径列表。
	 */
	@pittypat.ParameterAnnotation(position = 2, direction = pittypat.ParameterDirection.OUT, maxLength = 300000)
	public String attachmentUrls;

	/**
	 * 初始化 Delete 类的一个新实例。
	 */
	public Delete() {
		super();

		// 发送用户的 Id
		this.senderId = null;
		// 通知 Id 的列表
		this.ids = null;
		// 附件路径列表
		this.attachmentUrls = null;
	}

	/**
	 * 获取指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @return 指定名称的参数值。
	 */
	@Override
	public Object getParameterValue(String name) {
		if (name == null || name.length() == 0) {
			return null;
		}

		switch (name.toLowerCase()) {
			case "senderid":
				return this.senderId;
			case "ids":
				return this.ids;
			case "attachmenturls":
				return this.attachmentUrls;
			default:
				return null;
		}
	}

	/**
	 * 设置指定名称的参数值。
	 * 
	 * @param name
	 * 			参数名称，不区分大小写。
	 * @param value
	 * 			参数值。
	 * 
	 * @throws IllegalArgumentException
	 */
	@Override
	public void setParameterValue(String name, Object value) throws IllegalArgumentException {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("没有提供有效的参数名称。");
		}

		switch (name.toLowerCase()) {
			case "senderid":
				this.senderId = (java.util.UUID) value;
				break;
			case "ids":
				this.ids = (String) value;
				break;
			case "attachmenturls":
				this.attachmentUrls = (String) value;
				break;
			default:
				throw new IllegalArgumentException(name + " 不是 " + this.getClass().getName() + " 的有效参数属性名称。");
		}
	}

	/**
	 * 将当前对象作为 JSON 字符串写入指定的文本流。
	 * 
	 * @param writer
	 * 			目标文本流。
	 * 
	 * @throws IllegalArgumentException
	 * @throws java.io.IOException
	 */
	@Override
	public void write(java.io.Writer writer) throws IllegalArgumentException, java.io.IOException {
		if (writer == null) {
			throw new IllegalArgumentException("writer 为 null。");
		}

		writer.write('{');

		// 发送用户的 Id
		writer.write("\"senderId\":");
		pittypat.Json.write(writer, this.senderId);
		writer.write(',');

		// 通知 Id 的列表
		writer.write("\"ids\":");
		pittypat.Json.write(writer, this.ids);
		writer.write(',');

		// 附件路径列表
		writer.write("\"attachmentUrls\":");
		pittypat.Json.write(writer, this.attachmentUrls);

		writer.write('}');
	}
}
